调用ExecuteStatement接口对指定RDS数据库执行SQL语句-阿里云帮助中心

调用ExecuteStatement接口对指定数据库执行SQL语句。

接口说明

本接口当前仅支持华东 1（杭州）、华北 2（北京）地域的 Serverless 实例使用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SecretArn	string	是	Data API 账号的用户凭证，您可调用 DescribeSecrets 接口获取该参数的值。格式如下：`acs:rds:{{region}}:{{accountId}}:rds-db-credentials/{{secretName}}-{{6 digits random string}}`	acs:rds-api:cn-hangzhou:1266348003****:rds-db-credentials/mySecret-Uy**
ResourceArn	string	是	用于指向用户希望访问的资源，格式如下：`acs:rds:{{regionId}}:{{accountId}}:dbinstance/{{instanceId}}` 参数说明如下： regionId：地域 ID，可调用 DescribeSecrets 接口获取。 accountId：阿里云账号 ID，可调用 DescribeSecrets 接口获取。 instanceId：实例 ID。	acs:rds:cn-hangzhou:1266348003****:dbinstance/rm-1234567890abc**
Database	string	是	数据库名称。	test
ContinueAfterTimeout	boolean	否	如果调用超时，选择是否继续运行 SQL 语句，取值如下： true：继续运行 false：停止运行说明默认情况下，SQL 语句在调用超时后停止运行。	true
FormatRecordsAs	string	否	是否将结果集格式化为单个 JSON 字符串。仅允许传入 NONE 或 JSON。默认值为 NONE。此参数仅适用于 SELECT 语句，对于其他类型的语句将被忽略。结果将返回在 formattedRecords 中。	JSON
IncludeResultMetadata	boolean	否	是否在结果中包含元数据的值，取值如下： true：包含 false：不包含	true
Sql	string	是	需要执行的 SQL 语句。	select * from users
TransactionId	string	否	已启动的事务 ID，您可调用 BeginTransaction 接口获取该参数的值。	8609**-94e1-45ce-8e25-354e3dd8**
Parameters	array	否	待执行 SQL 语句的参数详情。
	SqlParameter	否	参数值，详情请参见 SqlParameter 。
ResultSetOptions	object	否	控制如何返回结果集的选项。
DecimalReturnType	string	否	指定 DECIMAL 类型返回后，允许显示的数据类型。 STRING：将字段转换为 String 值。 DOUBLE_OR_LONG：如果它的 scale 为 0，则将字段转换为 Long 值，否则转换为 Double 值。	STRING
LongReturnType	string	否	指定 LONG 类型返回后，允许显示的数据类型。允许取值为 LONG 或 STRING。默认值为 LONG。如果数值的长度或精度可能导致截断或舍入错误，建议请指定 STRING。	STRING

返回参数

名称	类型	描述	示例值
	object	返回参数如下。
RequestId	string	请求 ID。	CDAEE474-87E5-5AE3-A534-922F90D5867D
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
Code	string	状态码。	200
Message	string	错误信息。	There is an error in the call.
Data	ExecuteStatementResult	返回数据，详情请参见 ExecuteStatementResult 。

示例

正常返回示例

JSON格式

{
  "RequestId": "CDAEE474-87E5-5AE3-A534-922F90D5867D",
  "Success": true,
  "Code": "200",
  "Message": "There is an error in the call.",
  "Data": {
    "ColumnMetadata": [
      {
        "ArrayBaseColumnType": 1,
        "IsAutoIncrement": true,
        "IsCaseSensitive": true,
        "IsCurrency": true,
        "IsSigned": false,
        "Label": "TBL_BIG",
        "Name": "name",
        "Nullable": 1,
        "Precision": 1,
        "Scale": 2,
        "SchemaName": "test_schema",
        "TableName": "users",
        "Type": 93,
        "TypeName": "TIMESTAMP"
      }
    ],
    "FormattedRecords": "[{ \"name\": \"jack\" }]",
    "GeneratedFields": [
      {
        "ArrayValue": "[item1, item2, item3]",
        "BlobValue": "aGVsbG8=",
        "BooleanValue": true,
        "IsNull": true,
        "LongValue": 3213212,
        "StringValue": "I am a string"
      }
    ],
    "NumberOfRecordsUpdated": 2,
    "Records": [
      [
        {
          "ArrayValue": "[item1, item2, item3]",
          "BlobValue": "aGVsbG8=",
          "BooleanValue": true,
          "IsNull": true,
          "LongValue": 3213212,
          "StringValue": "I am a string"
        }
      ]
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-09-14

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。